home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1998 June / Software of the Month Club 1998 June.iso / pc / dos / biz / sharecon / sharecon.man < prev    next >
Text File  |  1998-04-15  |  24KB  |  419 lines
  1.            WaverlyStreet ShareCon (tm) version 2.3 - USER'S MANUAL
  2. -----------------------------------------------------------------------------
  3. Note: if you have not already done so, you might want to print this manual on
  4. paper. If you are reading it on screen from the ShareCon installation or help
  5. utility, press <P> to print it out (it is about 8 pages long).
  6.  
  7. -----------------------------------------------------------------------------
  8. Getting started
  9. -----------------------------------------------------------------------------
  10. When you start ShareCon for the very first time, the blank "reminder" screen
  11. comes up, along with a note that no editor has been specified on the command
  12. line. For now, press any key to clear this and get to the main screen. The top
  13. line of the screen shows all the available command options. Keys that "work"
  14. at a given screen are shown in brackets like so: <ESC>(the escape key),
  15. <F1>(the F1 key), <INS>(the insert key), and so on. Just to the right of <ESC>
  16. there are four tiny arrows. These indicate which of the keyboard "arrow" keys
  17. work at a given screen. Press the right arrow key, and the Keywords box on the
  18. right side of the screen shifts color to indicate that it is "on". Notice that
  19. the right arrow is no longer shown on the top line of the screen. This is
  20. because the right arrow does not do anything in the Keywords box. Press the
  21. left arrow key to return to the main screen. Notice that <TAB> is an option at
  22. the main screen. Press it, and more main screen command options will be shown.
  23.  
  24. The best way to become familiar with ShareCon is to simply start playing
  25. around with it. The remainder of this manual is broken into sections which
  26. explain the various ShareCon operations. I have attempted to place the
  27. sections in order, so that one can follow through and try each operation in
  28. turn, and emerge at the end pretty much familiar with the program.
  29.  
  30. -----------------------------------------------------------------------------
  31. Add new entries
  32. -----------------------------------------------------------------------------
  33. Press <INS> at the main screen. You must press either "i" or "o" to tag the
  34. new entry as an individual or an organization. Next, you must press either "r"
  35. or "p" to tag the entry as personal or public.
  36.  
  37. Now, move the pointer to the first line item you wish to fill in and press
  38. <ENTER>. Type in the information. Press <ENTER>, or <TAB>, or the up or down
  39. arrow keys to move to another field. Press <ESC> when you are finished. If you
  40. select KEYWORDS, you will need to tell the program which keyword you want to
  41. work with (use the up and down arrows to point to 1, 2, or 3). Press any key
  42. except "d", and the full keyword sub-system is activated. You may enter new
  43. keywords, edit them, or delete them, just as if you selected the keyword
  44. function at the main screen. But, to simply select an exiting keyword from the
  45. list, use the arrow keys and the <PGUP> and <PGDN> keys to point to the word
  46. you want, and press <ENTER>. The selected keyword will be displayed on screen
  47. along with the rest of the record.
  48.  
  49. When you are done making changes, press <F2> to save the new entry. The new
  50. record will be placed in alphabetical order.
  51.  
  52. -----------------------------------------------------------------------------
  53. The keywords sub-system
  54. -----------------------------------------------------------------------------
  55. The keywords sub-system may be activated from several different places within
  56. the program. At the main screen, press the right arrow key. Think of the
  57. keywords sub-system as an index to the main records.
  58.  
  59. When activated, the keyword list on the right side of the screen changes color
  60. to indicate that it is "on". Note the function key selection at the top of the
  61. screen.
  62.  
  63. To add a new keyword, press <INS>. Type it in and press <ENTER>. Now indicate
  64. whether the new keyword is personal or public. If you select personal, the
  65. keyword will have a tilde (~) appended to it. In either case, the keywords
  66. file is re-sorted and re-displayed. Personal keywords will drift to the bottom
  67. of the list.
  68.  
  69. If you don't like one of your keywords, you may edit it or delete it. Press
  70. <F3> to edit. The keyword list again shifts color. Use the arrows and <PGUP>
  71. <PGDN> to point to the keyword in question, and press <ENTER>. Type in a
  72. replacement for it, and indicate whether it is to be personal or public.
  73. ShareCon will then change the keyword in the keyword file, and also in every
  74. record containing it.
  75.  
  76. To delete a keyword, press <DEL> while the keyword list in "on". The keyword
  77. list will shift color. Use the up and down arrow keys and <PGUP> <PGDN> to
  78. point to the keyword in question, and press <ENTER>. ShareCon will remove the
  79. offending keyword, then offer you the option of either removing it from all
  80. the entries too, or doing nothing further. The default is to do nothing; that
  81. way, if you later change your mind and add the keyword back in, your records
  82. will still have it. It won't hurt anything to have "orphan" keywords in some
  83. of your records.
  84.  
  85. -----------------------------------------------------------------------------
  86. Printing
  87. -----------------------------------------------------------------------------
  88. Press <F4> at the main screen, or while in a keyword search. Select which type
  89. of record you wish to print; individuals, organizations, or both. Next, you
  90. must decide whether or not to select by keyword. (See the keywords section)
  91.  
  92. Next, indicate whether you want to print personal, public, or both classes of
  93. records.
  94.  
  95. Finally, select Phone list, Complete records, or Labels.
  96.  
  97. The Phone list option will print each record on a single line, with the phone
  98. number and fax number. The phone list option skips over records that do not
  99. have phone numbers.
  100.  
  101. If you choose complete records, then ShareCon will offer to print all
  102. non-empty fields in all selected records. The default is to print all fields,
  103. but you may remove fields that you do not wish to print on this particular
  104. list.
  105.  
  106. You may specify that the printed list have HTML code added, to make the E-Mail
  107. and URL fields work as active World Wide Web links. If this option is used,
  108. print the list to a file with the extension .htm, and use it as a web page
  109. without any other modification required.
  110.  
  111. If you select labels, you must specify standard or custom. Standard will print
  112. to 1" high, two label wide (20 labels per sheet) self-adhesive mailing address
  113. labels, which are available at office supply stores and the like. The custom
  114. option prints one address on five lines, and you specify how many blank lines
  115. go between addresses. (If you are a cheapskate like me, you may also print
  116. labels on plain paper, cut them out and use clear tape to stick them to
  117. envelopes (hey, it works fine!))
  118.  
  119. All print output initialy goes to the screen for review. Press "p" (while in
  120. the file browser) to print to paper or a file. You will be prompted to select
  121. a printer port, then the list will be printed. (Note: you can also start your
  122. external text editor from the file browser, and use the editor's print utility
  123. instead. See the section on external text editors below.)
  124.  
  125. If there is some problem with printing, then ShareCon will advise you to check
  126. your printer. It could be that you selected an invalid port, or that your
  127. printer is off-line or out of paper. Just look for obvious problems and try
  128. again.
  129.  
  130. -----------------------------------------------------------------------------
  131. Alphabetical search
  132. -----------------------------------------------------------------------------
  133. At the main screen, within a keyword search, or in the keywords system, press
  134. the space bar, and then the letter to which you would like to jump. The
  135. contacts or keywords display will jump to the first item starting with that
  136. letter.
  137.  
  138. -----------------------------------------------------------------------------
  139. Searching for a word
  140. -----------------------------------------------------------------------------
  141. In addition to the keywords system, ShareCon will search your records for any
  142. word you specify. (This utility searches all the fields in your records EXCEPT
  143. the keywords.) Press <F6> at the main screen, or from within a keyword search
  144. to begin. Type in either the entire word you need, or just the first several
  145. characters in the word. (This works with numbers, too; For example, to look at
  146. all your records for a certain telephone area code...) Once you have entered
  147. in your search pattern, press <ENTER>. If you like, ShareCon will make a list
  148. of all the records it finds (similar to a keyword search). Otherwise, each
  149. record in the data file is searched in turn. When a match is found, the
  150. complete record is displayed on screen. Press any key to continue the search.
  151. Press <ESC> to terminate searching.
  152.  
  153. -----------------------------------------------------------------------------
  154. Viewing & editing whole records
  155. -----------------------------------------------------------------------------
  156. At the main screen, use the up and down arrow keys and the <PGUP> and <PGDN>
  157. keys to point to the record you wish to view, and then press <ENTER>. The
  158. entire contents of the record will be displayed on screen. Press <PGUP> to see
  159. the previous record, <PGDN> the next. Press <ESC> at any time to return to the
  160. main screen.
  161.  
  162. To narrow your view to records containing a certain keyword, press the right
  163. arrow key at the main screen to activate the keywords sub-system, then use the
  164. arrow keys and the <PGUP> and <PGDN> keys to point to the desired keyword.
  165. Press <ENTER>, and you will be presented with a "short list" that consists
  166. only of records containing that keyword. You may now view the "short list"
  167. just as you would the full list.
  168.  
  169. To edit a record, press <F3> (while viewing the entire record). Move the
  170. pointer to the line item you wish to change and press <ENTER>. Type in the new
  171. information. Press ENTER, TAB, or the up or down arrow key to go to the next
  172. or previous field. Press <ESC> to stop. When you are done making changes,
  173. press <F2> to save the revised entry. If you want to abandon your changes,
  174. press <ESC> instead. If you have changed the field that the program uses to
  175. sort the file (lastname or organization name) then ShareCon will offer to
  176. re-sort it right then. The default is not to re-sort. (Note - when editing
  177. from within a keyword search, there will be no offer to re-sort).
  178.  
  179. To delete a record, you must be viewing the full record from the main screen
  180. (not from within a keyword search). Press <DEL> (while viewing the entire
  181. record). You are given a chance to change your mind. To go through with the
  182. deletion, you must press the "y" key.
  183.  
  184. A new feature in version 2.2 allows printing a single record. While viewing a
  185. full record, just press <F4> and specify the printer port. The output is name
  186. and address (in the form of a mailing label) plus phone and fax number. This
  187. is handy for printing several unrelated address labels "on the fly".
  188.  
  189. -----------------------------------------------------------------------------
  190. Sort your records
  191. -----------------------------------------------------------------------------
  192. Merging with other users and editing records will eventually cause your
  193. records to become out of order. Press <F5> at the main menu to sort your
  194. records alphabetically. ShareCon lists individuals and organizations together.
  195. They are sorted as follows: individuals are evaluated by their last names, and
  196. organizations are evaluated by the organization name. If you begin sorting,
  197. and it is taking too long, press the <ESC> key to cancel the operation. Save
  198. it for some other time when you aren't so busy, or let it run when you are
  199. away from your desk. (Or, if running ShareCon under Windows, set the
  200. background processing option "on" (see your Windows manual).)
  201.  
  202. -----------------------------------------------------------------------------
  203. Backup / merge functions
  204. -----------------------------------------------------------------------------
  205. At the main screen, press <F7> to bring up the ShareCon DISK UTILITIES MENU.
  206. This is where you backup and restore your files, and create or read merge
  207. files for or from other users of ShareCon. Press the number of your selection
  208. to activate it.
  209.  
  210.                      BACKUP *ALL* FILES TO FLOPPY DRIVE
  211.  
  212. This is just a common-sense periodic backup utility. It copies the files
  213. CONTACTS.DAT and KEYWORDS.DAT to a floppy disk for safe-keeping. The files are
  214. named CONTACTS.BAK and KEYWORDS.BAK on the floppy disk. You must specify a
  215. target drive letter. This utility will OVERWRITE any previous CONTACTS.BAK or
  216. KEYWORDS.BAK files on the target disk, without warning.
  217.  
  218.                CREATE PUBLIC MERGE FILES (No Personal Entries)
  219.  
  220. This utility creates merge files that you can share with others. First, a
  221. couple things to keep in mind:
  222.  
  223.       Only records and keywords that are tagged as PUBLIC will be
  224.       written to the merge file.
  225.  
  226.       In the case of a PUBLIC record which contains PERSONAL
  227.       keywords, the PERSONAL keywords are stripped out of the
  228.       merge file record.
  229.  
  230.       Only PUBLIC keywords that are used in the selected records
  231.       will be written to the merge file.
  232.  
  233. To use the utility, press 2 at the disk utilities menu. Now indicate whether
  234. or not you wish to select by keyword. If you chose to select by keyword, the
  235. keyword box will shift colors and then you use the arrow keys and the <PGUP>
  236. and <PGDN> keys to point to the desired keyword, and press <ENTER>. In either
  237. case, you must then specify a target drive letter. The appropriate records
  238. will then be processed and written to the files CONTACT.MER and KEYWORD.MER on
  239. the target drive. This utility will OVERWRITE any previous CONTACT.MER or
  240. KEYWORD.MER files on the target disk, without warning.
  241.  
  242.                   MERGE CURRENT FILES WITH FLOPPY DISK FILES
  243.  
  244. This is where you incorporate someone else's merge files into your records, or
  245. restore backed up records. To run it, press 3 at the utility menu. (It would
  246. be a good idea to go back to the utility menu and run the backup item if you
  247. have not done so lately.)
  248.  
  249. Once you indicate that you do want to continue, you must type in the drive
  250. letter containing the merge files. Just press the letter of the drive.
  251. (ShareCon will look for files in the root directory of the drive.)
  252.  
  253. Now, press "p" or "b", to indicate whether the program is to look for (P)ublic
  254. merge files or (B)ackup files.
  255.  
  256. Next, you need to tell the program how to handle any apparent duplicate
  257. records that it finds in the backup or merge files. (Records are considered
  258. duplicates if the last name, first name, and organization name all match. The
  259. comparison is NOT case-sensitive.) There are two options: The default is to
  260. reject the duplicate from the merge file, and only keep your original record.
  261. This way, you can rest assured that none of your existing records will be
  262. modified. The other option is to have the program compare the apparent
  263. duplicate's date/time stamps, and keep whichever of the two is newer. This is
  264. convienent when you know that some of your records are out of date, and that
  265. the the merge file contains more current records.
  266.  
  267. ShareCon will now extract each new record in turn, compare them to your
  268. existing records, and produce new data files which contain both sets, as you
  269. have specified.
  270.  
  271.                MAKE NEW DATE/TIME STAMP ON ALL RECORDS NOW
  272.  
  273. If you wish to make absolutely sure that the records in your merge files are
  274. favored during a merge operation on another machine, run this utility first,
  275. then create the merge file. Or, to make sure your existing records are
  276. retained during a merge, run this just prior to merging things IN.
  277.  
  278. Note: In all the DISK UTILITIES functions, keep in mind that you can use hard
  279. drives and/or RAM drives instead of proper floppy drives. So for instance,
  280. when you are merging network records into your local records, you don't *have*
  281. to mess around with floppy disks.
  282.  
  283. -----------------------------------------------------------------------------
  284. External text editors
  285. -----------------------------------------------------------------------------
  286. When you have printed a list to the screen, you may call up an external text
  287. editor and modify / "mark up" the list. (ShareCon does not have it's own text
  288. editor; it uses whichever editor you specify.) The external editor is
  289. specified on the DOS command line, or in a Windows program item command line
  290. field, in this format: sc[version number] [complete path and file spec for
  291. editor executable]. Note the space between the sharecon call and the editor
  292. call. For example, to use the READ editor with ShareCon 2.3, type:
  293.  
  294.      sc23 read
  295.  
  296. on the command line. If no editor is specified on the command line, ShareCon
  297. will attempt to use EDIT. (EDIT was furnished with MS-DOS version 5 and on (I
  298. believe). EDIT is not particularly satisfying, but works OK as long as your
  299. lists are not very long. Much better suited is a shareware editor called READ.
  300. READ can be found on the internet at http://users.aol.com/wellscom/ , or at
  301. any of the major shareware archives.
  302.  
  303. -----------------------------------------------------------------------------
  304. Data directories
  305. -----------------------------------------------------------------------------
  306. By default, ShareCon places its data files in the same directory that the
  307. program resides in. However, you may change this in one of two ways.
  308.  
  309. First, you may specify a different directory in SETUP. (See SETUP)
  310. Alternately, you may change data directories "on the fly" from within the
  311. program. Press <F9> at the main screen to do this. Press "y", and type in a
  312. new path. If the new path that you ask for cannot be found, you are prompted
  313. to try again. Note - if you leave the new path entry blank, the program will
  314. automatically select the directory in which the program resides.
  315.  
  316. Network notes: The fact that ShareCon has the ability to access remote drives
  317. and directories is not meant to imply that the program is completely "network
  318. compatible". For one thing, to use "common" data exclusively would sort of
  319. defeat one of the main ideas behind ShareCon; that being the home/work,
  320. personal/business portability. Additionally, although steps were taken to make
  321. ShareCon able to operate in a network environment, that was not a main goal,
  322. and you might find the operation a little "clunky" and confusing when several
  323. users are accessing the same files. It is also (remotely) possible that
  324. records could be over-written, under certain circumstances, where two users
  325. were editing at the very same time.
  326.  
  327. The reason for the (rudimentary) network compatibility is so that one person
  328. in an office can be given the task of maintaining an "official" list (or
  329. lists). Other users may then change to the "official" list from time to time
  330. (by pressing F9), and create merge files for themselves, without bothering the
  331. person who maintains the "official" files. Constant use of network data files
  332. in a group environment is NOT advised.
  333.  
  334. -----------------------------------------------------------------------------
  335. Setup
  336. -----------------------------------------------------------------------------
  337. There are a number of user-defined characteristics of ShareCon that you may
  338. modify by using the SETUP utility. To start SETUP, press <F10> at the main
  339. screen. Select a SETUP option with the arrow keys and <ENTER>. Press <ESC> to
  340. leave setup and save all configuration information.
  341.  
  342. PASSCODE: If the passcode is set to anything other than 0, then the program
  343. will require that the correct passcode be entered upon start-up. The passcode
  344. may be up to four characters long, and each character must be one of the
  345. numbers 0 through 9.
  346.  
  347. PRINT X LINES PER PAGE: Specify a number of lines to print between form feeds,
  348. for the file browser print utility.
  349.  
  350. SCREEN COLORS: Select this item to run the color configuration utility. To
  351. modify an item, move the pointer to it and press <ENTER>. The color will be
  352. changed to the next highest color number. (0 through 7 for backgrounds, 0
  353. through 15 for foregrounds.) Once you have the colors the way you want them,
  354. select "Save these colors and EXIT". You may also return to the default
  355. colors. (Note: you must "save" the default colors too.)
  356.  
  357. DATA PATH: If you wish to have ShareCon access data files in some other drive
  358. and/or directory on startup, specify that path here.
  359.  
  360. SCRATCH FILE PATH: Certain ShareCon functions make extensive use of temporary
  361. files. If you have a RAM drive set up on your computer, you may experience
  362. some increased performance by directing ShareCon to use the RAM drive for
  363. these "scratch" files. The RAM drive needs to be larger than your largest
  364. CONTACTS.DAT file. See your DOS manual for information on RAMDRIVE.SYS.
  365.  
  366. REMINDER UTILITY: ShareCon incorporates a (completely un-related) little
  367. utility to help make sure that you don't forget up to 10 "VERY IMPORTANT BITS
  368. OF INFORMATION". You may toggle the reminder utility to run either every time
  369. you start the program, not at all, or only every time you start the program in
  370. a new month (my favorite). To toggle the operational mode, select Show
  371. Reminders: and press <ENTER>. To enter a new, or edit an existing reminder,
  372. point to it and press <ENTER>. Work on the date, press <ENTER>, and then do
  373. the note (and press <ENTER>). To have a look at your reminders anytime, press
  374. <F10> at the main screen.
  375.  
  376. -----------------------------------------------------------------------------
  377. Getting the most out of ShareCon
  378. -----------------------------------------------------------------------------
  379. *    Use it often. As with anything else, the more you use it, the quicker
  380.      and easier it becomes.
  381.  
  382. *    Run it all the time in a DOS window from Windows, switching in and out
  383.      with ALT-TAB. Place it in the Windows start-up group so it starts
  384.      automatically when you start Windows.
  385.  
  386. *    Choose keywords carefully. If working in a group of people, it might be
  387.      a good idea for the group to discuss what keywords to use, before you
  388.      get too far into entering data. Don't make your keywords overly
  389.      specific, and don't use so many of them that browsing the keywords list
  390.      is confusing. Use a hierarchical system - in a large group of related
  391.      records, make the first keyword a broad one, the second more specific,
  392.      and the third even more specific.
  393.  
  394. *    If working in a group, have one person set up an initial data file with
  395.      the agreed-upon keywords structure, then have the other users merge that
  396.      in and go from there with their own personal records. The other users
  397.      will be much more likely to stick with the group keyword structure if it
  398.      is already set up for them, and subsequent merging of records will be
  399.      much more efficient if everyone is using the same general structure.
  400.  
  401. *    Load up the NOTES fields with words that pertain to the record, and use
  402.      the search by word feature (F6).
  403.  
  404. -----------------------------------------------------------------------------
  405. Upgrading from a previous version (2.0 and prior)
  406. -----------------------------------------------------------------------------
  407. ShareCon version 2.1+ uses a slightly different data format than versions 2.0
  408. and prior. The older version files were named CONTACTS.DAT and KEYWORDS.DAT.
  409. The new files are named CONTACT.DAT and KEYWORD.DAT. To make your old data
  410. files useable, you must run them through the conversion utility, SC21DATA.EXE.
  411. This utility is available at the WaverlyStreet web site, or write and ask for
  412. it. Either way, it's free.
  413.  
  414. -----------------------------------------------------------------------------
  415.    ShareCon (tm) Copyright (C) WaverlyStreet, 1996-97. All Rights Reserved.
  416. -----------------------------------------------------------------------------
  417.           WaverlyStreet, P.O. Box 14249, Columbus, Ohio, 43214 (US)
  418. -----------------------------------------------------------------------------
  419.